home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / dptsvx.z / dptsvx
Text File  |  1996-03-14  |  7KB  |  199 lines

  1.  
  2.  
  3.  
  4. DDDDPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))                                                          DDDDPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DPTSVX - use the factorization A = L*D*L**T to compute the solution to a
  10.      real system of linear equations A*X = B, where A is an N-by-N symmetric
  11.      positive definite tridiagonal matrix and X and B are N-by-NRHS matrices
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE DPTSVX( FACT, N, NRHS, D, E, DF, EF, B, LDB, X, LDX, RCOND,
  15.                         FERR, BERR, WORK, INFO )
  16.  
  17.          CHARACTER      FACT
  18.  
  19.          INTEGER        INFO, LDB, LDX, N, NRHS
  20.  
  21.          DOUBLE         PRECISION RCOND
  22.  
  23.          DOUBLE         PRECISION B( LDB, * ), BERR( * ), D( * ), DF( * ), E(
  24.                         * ), EF( * ), FERR( * ), WORK( * ), X( LDX, * )
  25.  
  26. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  27.      DPTSVX uses the factorization A = L*D*L**T to compute the solution to a
  28.      real system of linear equations A*X = B, where A is an N-by-N symmetric
  29.      positive definite tridiagonal matrix and X and B are N-by-NRHS matrices.
  30.  
  31.      Error bounds on the solution and a condition estimate are also provided.
  32.  
  33.  
  34. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  35.      The following steps are performed:
  36.  
  37.      1. If FACT = 'N', the matrix A is factored as A = L*D*L**T, where L
  38.         is a unit lower bidiagonal matrix and D is diagonal.  The
  39.         factorization can also be regarded as having the form
  40.         A = U**T*D*U.
  41.  
  42.      2. The factored form of A is used to compute the condition number
  43.         of the matrix A.  If the reciprocal of the condition number is
  44.         less than machine precision, steps 3 and 4 are skipped.
  45.  
  46.      3. The system of equations is solved for X using the factored form
  47.         of A.
  48.  
  49.      4. Iterative refinement is applied to improve the computed solution
  50.         matrix and calculate error bounds and backward error estimates
  51.         for it.
  52.  
  53.  
  54. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  55.      FACT    (input) CHARACTER*1
  56.              Specifies whether or not the factored form of A has been supplied
  57.              on entry.  = 'F':  On entry, DF and EF contain the factored form
  58.              of A.  D, E, DF, and EF will not be modified.  = 'N':  The matrix
  59.              A will be copied to DF and EF and factored.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))                                                          DDDDPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      NRHS    (input) INTEGER
  78.              The number of right hand sides, i.e., the number of columns of
  79.              the matrices B and X.  NRHS >= 0.
  80.  
  81.      D       (input) DOUBLE PRECISION array, dimension (N)
  82.              The n diagonal elements of the tridiagonal matrix A.
  83.  
  84.      E       (input) DOUBLE PRECISION array, dimension (N-1)
  85.              The (n-1) subdiagonal elements of the tridiagonal matrix A.
  86.  
  87.      DF      (input or output) DOUBLE PRECISION array, dimension (N)
  88.              If FACT = 'F', then DF is an input argument and on entry contains
  89.              the n diagonal elements of the diagonal matrix D from the
  90.              L*D*L**T factorization of A.  If FACT = 'N', then DF is an output
  91.              argument and on exit contains the n diagonal elements of the
  92.              diagonal matrix D from the L*D*L**T factorization of A.
  93.  
  94.      EF      (input or output) DOUBLE PRECISION array, dimension (N-1)
  95.              If FACT = 'F', then EF is an input argument and on entry contains
  96.              the (n-1) subdiagonal elements of the unit bidiagonal factor L
  97.              from the L*D*L**T factorization of A.  If FACT = 'N', then EF is
  98.              an output argument and on exit contains the (n-1) subdiagonal
  99.              elements of the unit bidiagonal factor L from the L*D*L**T
  100.              factorization of A.
  101.  
  102.      B       (input) DOUBLE PRECISION array, dimension (LDB,NRHS)
  103.              The N-by-NRHS right hand side matrix B.
  104.  
  105.      LDB     (input) INTEGER
  106.              The leading dimension of the array B.  LDB >= max(1,N).
  107.  
  108.      X       (output) DOUBLE PRECISION array, dimension (LDX,NRHS)
  109.              If INFO = 0, the N-by-NRHS solution matrix X.
  110.  
  111.      LDX     (input) INTEGER
  112.              The leading dimension of the array X.  LDX >= max(1,N).
  113.  
  114.      RCOND   (output) DOUBLE PRECISION
  115.              The reciprocal condition number of the matrix A.  If RCOND is
  116.              less than the machine precision (in particular, if RCOND = 0),
  117.              the matrix is singular to working precision.  This condition is
  118.              indicated by a return code of INFO > 0, and the solution and
  119.              error bounds are not computed.
  120.  
  121.      FERR    (output) DOUBLE PRECISION array, dimension (NRHS)
  122.              The forward error bound for each solution vector X(j) (the j-th
  123.              column of the solution matrix X).  If XTRUE is the true solution
  124.              corresponding to X(j), FERR(j) is an estimated upper bound for
  125.              the magnitude of the largest element in (X(j) - XTRUE) divided by
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))                                                          DDDDPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              the magnitude of the largest element in X(j).
  141.  
  142.      BERR    (output) DOUBLE PRECISION array, dimension (NRHS)
  143.              The componentwise relative backward error of each solution vector
  144.              X(j) (i.e., the smallest relative change in any element of A or B
  145.              that makes X(j) an exact solution).
  146.  
  147.      WORK    (workspace) DOUBLE PRECISION array, dimension (2*N)
  148.  
  149.      INFO    (output) INTEGER
  150.              = 0:  successful exit
  151.              < 0:  if INFO = -i, the i-th argument had an illegal value
  152.              > 0:  if INFO = i, and i is <= N  the leading minor of order i of
  153.              A is not positive definite, so the factorization could not be
  154.              completed unless i = N, and the solution and error bounds could
  155.              not be computed.  = N+1 RCOND is less than machine precision.
  156.              The factorization has been completed, but the matrix is singular
  157.              to working precision, and the solution and error bounds have not
  158.              been computed.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.